<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>JdbcBasicGenericDao xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/genericdao/springjdbc/JdbcBasicGenericDao.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: JdbcBasicGenericDao.html 11 2009-01-29 14:58:33Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://genericdao.googlecode.com/svn/maven/site/xref/org/sakaiproject/genericdao/springjdbc/JdbcBasicGenericDao.html $</em>
<a name="4" href="#4">4</a>   <em> * JdbcBasicGenericDao.java - genericdao - Apr 26, 2008 12:27:46 AM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Aaron Zeckoski</em>
<a name="7" href="#7">7</a>   <em> * Licensed under the Apache License, Version 2</em>
<a name="8" href="#8">8</a>   <em> * </em>
<a name="9" href="#9">9</a>   <em> * A copy of the Apache License, Version 2 has been included in this </em>
<a name="10" href="#10">10</a>  <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> * Aaron Zeckoski (azeckoski@gmail.com) (aaronz@vt.edu) (aaron@caret.cam.ac.uk)</em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.sakaiproject.genericdao.springjdbc;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.io.Serializable;
<a name="18" href="#18">18</a>  <strong>import</strong> java.util.ArrayList;
<a name="19" href="#19">19</a>  <strong>import</strong> java.util.List;
<a name="20" href="#20">20</a>  <strong>import</strong> java.util.Map;
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> javax.sql.DataSource;
<a name="23" href="#23">23</a>  
<a name="24" href="#24">24</a>  <strong>import</strong> org.azeckoski.reflectutils.ArrayUtils;
<a name="25" href="#25">25</a>  <strong>import</strong> org.sakaiproject.genericdao.api.BasicGenericDao;
<a name="26" href="#26">26</a>  <strong>import</strong> org.sakaiproject.genericdao.api.finders.ByPropsFinder;
<a name="27" href="#27">27</a>  <strong>import</strong> org.sakaiproject.genericdao.api.mappers.DataMapper;
<a name="28" href="#28">28</a>  <strong>import</strong> org.sakaiproject.genericdao.api.mappers.NamesRecord;
<a name="29" href="#29">29</a>  <strong>import</strong> org.sakaiproject.genericdao.api.mappers.StatementMapper;
<a name="30" href="#30">30</a>  <strong>import</strong> org.sakaiproject.genericdao.api.search.Order;
<a name="31" href="#31">31</a>  <strong>import</strong> org.sakaiproject.genericdao.api.search.Restriction;
<a name="32" href="#32">32</a>  <strong>import</strong> org.sakaiproject.genericdao.api.search.Search;
<a name="33" href="#33">33</a>  <strong>import</strong> org.sakaiproject.genericdao.api.translators.DatabaseTranslator;
<a name="34" href="#34">34</a>  <strong>import</strong> org.sakaiproject.genericdao.springjdbc.translators.BasicTranslator;
<a name="35" href="#35">35</a>  <strong>import</strong> org.sakaiproject.genericdao.util.JDBCUtils;
<a name="36" href="#36">36</a>  <strong>import</strong> org.sakaiproject.genericdao.util.JDBCUtils.QueryData;
<a name="37" href="#37">37</a>  
<a name="38" href="#38">38</a>  <em>/**<em>*</em></em>
<a name="39" href="#39">39</a>  <em> * Spring JDBC based implementation of BasicGenericDao which can be extended to add more</em>
<a name="40" href="#40">40</a>  <em> * specialized DAO methods.</em>
<a name="41" href="#41">41</a>  <em> * &lt;p></em>
<a name="42" href="#42">42</a>  <em> * See the overview for installation/usage tips.</em>
<a name="43" href="#43">43</a>  <em> * </em>
<a name="44" href="#44">44</a>  <em> * @author Aaron Zeckoski (azeckoski@gmail.com)</em>
<a name="45" href="#45">45</a>  <em> */</em>
<a name="46" href="#46">46</a>  @SuppressWarnings(<span class="string">"deprecation"</span>)
<a name="47" href="#47">47</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/JdbcBasicGenericDao.html">JdbcBasicGenericDao</a> <strong>extends</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/JdbcGenericDao.html">JdbcGenericDao</a> implements <a href="../../../../org/sakaiproject/genericdao/api/BasicGenericDao.html">BasicGenericDao</a> {
<a name="48" href="#48">48</a>  
<a name="49" href="#49">49</a>      <em>/**<em>*</em></em>
<a name="50" href="#50">50</a>  <em>     * Default constructor - does nothing and leaves the object in an incomplete state,</em>
<a name="51" href="#51">51</a>  <em>     * you need to at least set the following:</em>
<a name="52" href="#52">52</a>  <em>     * {@link #setDataSource(DataSource)} &lt;br/></em>
<a name="53" href="#53">53</a>  <em>     * {@link #setAutoDDL(boolean)} &lt;br/></em>
<a name="54" href="#54">54</a>  <em>     * {@link #setAutoCommitDDL(boolean)} &lt;br/></em>
<a name="55" href="#55">55</a>  <em>     * {@link #setDatabaseType(String)} &lt;br/></em>
<a name="56" href="#56">56</a>  <em>     * {@link #setDataMappers(List)} &lt;br/></em>
<a name="57" href="#57">57</a>  <em>     * &lt;br/></em>
<a name="58" href="#58">58</a>  <em>     * This does not actually start the DAO, run {@link #startup()} to start it &lt;br/></em>
<a name="59" href="#59">59</a>  <em>     * Note that this will be started automatically by Spring if this is created as a Spring bean,</em>
<a name="60" href="#60">60</a>  <em>     * no actions are necessary and setting an init method is not needed</em>
<a name="61" href="#61">61</a>  <em>     */</em>
<a name="62" href="#62">62</a>      <strong>public</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/JdbcBasicGenericDao.html">JdbcBasicGenericDao</a>() {
<a name="63" href="#63">63</a>          <strong>super</strong>();
<a name="64" href="#64">64</a>      }
<a name="65" href="#65">65</a>  
<a name="66" href="#66">66</a>      <em>/**<em>*</em></em>
<a name="67" href="#67">67</a>  <em>     * Complete constructor, sets all required values for running the DAO,</em>
<a name="68" href="#68">68</a>  <em>     * does not actually start the DAO, run {@link #startup()} to start it &lt;br/></em>
<a name="69" href="#69">69</a>  <em>     * Note that this will be started automatically by Spring if this is created as a Spring bean,</em>
<a name="70" href="#70">70</a>  <em>     * no actions are necessary and setting an init method is not needed</em>
<a name="71" href="#71">71</a>  <em>     * </em>
<a name="72" href="#72">72</a>  <em>     * @param dataSource the DataSource to use with this DAO</em>
<a name="73" href="#73">73</a>  <em>     * @param threadBoundDataSource if true then the DataSource will be bound to threads and </em>
<a name="74" href="#74">74</a>  <em>     * only unbound and closed when {@link #closeConnection()} is called,</em>
<a name="75" href="#75">75</a>  <em>     * otherwise a new DataSource is obtained each time, </em>
<a name="76" href="#76">76</a>  <em>     * this has no effect if the DataSource is a Spring DataSource</em>
<a name="77" href="#77">77</a>  <em>     * @param databaseType the databaseType that this DAO is connecting to (use constants in {@link DatabaseTranslator})</em>
<a name="78" href="#78">78</a>  <em>     * @param autoDDL if true then DDL is executed on DAO startup (can be run manually if desired)</em>
<a name="79" href="#79">79</a>  <em>     * @param autoCommitDDL if true then commit is executed after each DDL file is executed, if false then you need a TX manager to do this for you</em>
<a name="80" href="#80">80</a>  <em>     * @param dataMappers the data mappers which map this DAO to the tables</em>
<a name="81" href="#81">81</a>  <em>     */</em>
<a name="82" href="#82">82</a>      <strong>public</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/JdbcBasicGenericDao.html">JdbcBasicGenericDao</a>(DataSource dataSource, <strong>boolean</strong> threadBoundDataSource, 
<a name="83" href="#83">83</a>              String databaseType, <strong>boolean</strong> autoDDL, <strong>boolean</strong> autoCommitDDL, <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a>[] dataMappers) {
<a name="84" href="#84">84</a>          <strong>super</strong>(dataSource, threadBoundDataSource, databaseType, autoDDL, autoCommitDDL, dataMappers);
<a name="85" href="#85">85</a>      }
<a name="86" href="#86">86</a>  
<a name="87" href="#87">87</a>  
<a name="88" href="#88">88</a>      <strong>protected</strong> QueryData makeQueryFromSearch(Class&lt;?> type, <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search) {
<a name="89" href="#89">89</a>          <em class="comment">// Checks to see if the required params are set and throws exception if not</em>
<a name="90" href="#90">90</a>          <strong>if</strong> (search == <strong>null</strong>) {
<a name="91" href="#91">91</a>              <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"search cannot be null"</span>);
<a name="92" href="#92">92</a>          }
<a name="93" href="#93">93</a>  
<a name="94" href="#94">94</a>          <a href="../../../../org/sakaiproject/genericdao/api/mappers/NamesRecord.html">NamesRecord</a> namesRecord = getNamesRecord(type);
<a name="95" href="#95">95</a>          <strong>return</strong> JDBCUtils.makeSQLfromSearch(namesRecord, search);
<a name="96" href="#96">96</a>      }
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>  
<a name="99" href="#99">99</a>      <em class="comment">// OVERRIDES</em>
<a name="100" href="#100">100</a> 
<a name="101" href="#101">101</a>     <strong>protected</strong> &lt;T> <strong>long</strong> baseCountBySearch(Class&lt;T> type, <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search) {
<a name="102" href="#102">102</a>         QueryData sd = makeQueryFromSearch(type, search);
<a name="103" href="#103">103</a>         String sql = makeSQL(getSelectTemplate(type), getTableNameFromClass(type), 
<a name="104" href="#104">104</a>                 StatementMapper.SELECT, <span class="string">"count(*)"</span>, StatementMapper.WHERE, sd.getAfterTableSQL());
<a name="105" href="#105">105</a>         <strong>if</strong> (showSQL) {
<a name="106" href="#106">106</a>             logInfo(<span class="string">"SQL="</span>+sql+<span class="string">":\n Params="</span>+ArrayUtils.arrayToString(sd.getArgs()));
<a name="107" href="#107">107</a>         }
<a name="108" href="#108">108</a>         <strong>long</strong> count = getSpringJdbcTemplate().queryForLong(sql, sd.getArgs());
<a name="109" href="#109">109</a>         <strong>return</strong> count;
<a name="110" href="#110">110</a>     }
<a name="111" href="#111">111</a> 
<a name="112" href="#112">112</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="113" href="#113">113</a>     <strong>protected</strong> &lt;T> List&lt;T> baseFindBySearch(Class&lt;T> type, <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search) {
<a name="114" href="#114">114</a>         String tableName = getTableNameFromClass(type);
<a name="115" href="#115">115</a>         QueryData sd = makeQueryFromSearch(type, search);
<a name="116" href="#116">116</a>         String sql = makeSQL(getSelectTemplate(type), tableName, 
<a name="117" href="#117">117</a>                 StatementMapper.SELECT, tableName + <span class="string">".*"</span>, StatementMapper.WHERE, sd.getAfterTableSQL());
<a name="118" href="#118">118</a>         <em class="comment">// handle limit/offset</em>
<a name="119" href="#119">119</a>         <strong>int</strong> firstResult = (<strong>int</strong>) search.getStart();
<a name="120" href="#120">120</a>         <strong>int</strong> maxResults = (<strong>int</strong>) search.getLimit();
<a name="121" href="#121">121</a>         <strong>if</strong> (firstResult > 0 || maxResults > 0) {
<a name="122" href="#122">122</a>             sql = getDatabaseTranslator().makeLimitQuery(sql, search.getStart(), search.getLimit(), tableName);
<a name="123" href="#123">123</a>             getSpringJdbcTemplate().setMaxRows(firstResult + maxResults); <em class="comment">// this limit is always ok to put in</em>
<a name="124" href="#124">124</a>         }
<a name="125" href="#125">125</a>         <strong>if</strong> (showSQL) {
<a name="126" href="#126">126</a>             logInfo(<span class="string">"SQL="</span>+sql+<span class="string">":\n Params="</span>+ArrayUtils.arrayToString(sd.getArgs()));
<a name="127" href="#127">127</a>         }
<a name="128" href="#128">128</a>         List&lt;Map&lt;String, Object>> rMap = getSpringJdbcTemplate().queryForList(sql, sd.getArgs());
<a name="129" href="#129">129</a>         getSpringJdbcTemplate().setMaxRows(0); <em class="comment">// reset this to no limit</em>
<a name="130" href="#130">130</a>         List&lt;T> results = <strong>new</strong> ArrayList&lt;T>();
<a name="131" href="#131">131</a> 
<a name="132" href="#132">132</a>         <em class="comment">// put the results into objects</em>
<a name="133" href="#133">133</a>         <strong>int</strong> counter = 0;
<a name="134" href="#134">134</a>         <em class="comment">// SPECIAL handling for DERBY</em>
<a name="135" href="#135">135</a>         <strong>boolean</strong> derby = BasicTranslator.DBTYPE_DERBY.equals(getDatabaseType());
<a name="136" href="#136">136</a>         <strong>for</strong> (Map&lt;String, Object> data : rMap) {
<a name="137" href="#137">137</a>             <strong>if</strong> (derby) {
<a name="138" href="#138">138</a>                 <em class="comment">// derby has to filter results after the fact... lame yes indeed</em>
<a name="139" href="#139">139</a>                 <strong>if</strong> (counter &lt; firstResult) {
<a name="140" href="#140">140</a>                     counter++;
<a name="141" href="#141">141</a>                     <strong>continue</strong>;
<a name="142" href="#142">142</a>                 }
<a name="143" href="#143">143</a>                 <strong>if</strong> (maxResults > 0 &amp;&amp; results.size() >= maxResults) {
<a name="144" href="#144">144</a>                     <strong>break</strong>;
<a name="145" href="#145">145</a>                 }
<a name="146" href="#146">146</a>             }
<a name="147" href="#147">147</a>             T entity = makeEntityFromMap(type, data);
<a name="148" href="#148">148</a>             results.add(entity);
<a name="149" href="#149">149</a>             counter++;
<a name="150" href="#150">150</a>         }
<a name="151" href="#151">151</a>         <strong>return</strong> results;
<a name="152" href="#152">152</a>     }
<a name="153" href="#153">153</a> 
<a name="154" href="#154">154</a>     <strong>protected</strong> &lt;T> T baseFindOneBySearch(Class&lt;T> type, <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search) {
<a name="155" href="#155">155</a>         T item = <strong>null</strong>;
<a name="156" href="#156">156</a>         search.setLimit(1); <em class="comment">// only return 1 item</em>
<a name="157" href="#157">157</a>         List&lt;T> items = baseFindBySearch(type, search);
<a name="158" href="#158">158</a>         <strong>if</strong> (items.size() > 0) {
<a name="159" href="#159">159</a>             item = items.get(0);
<a name="160" href="#160">160</a>         }
<a name="161" href="#161">161</a>         <strong>return</strong> item;
<a name="162" href="#162">162</a>     }
<a name="163" href="#163">163</a> 
<a name="164" href="#164">164</a> 
<a name="165" href="#165">165</a>     <em class="comment">// COMMON CODE</em>
<a name="166" href="#166">166</a> 
<a name="167" href="#167">167</a>     <strong>public</strong> &lt;T> <strong>long</strong> countBySearch(Class&lt;T> type, <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search) {
<a name="168" href="#168">168</a>         checkClass(type);
<a name="169" href="#169">169</a>         <strong>if</strong> (search == <strong>null</strong>) {
<a name="170" href="#170">170</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"search cannot be null"</span>);
<a name="171" href="#171">171</a>         }
<a name="172" href="#172">172</a>         <strong>long</strong> count = 0;
<a name="173" href="#173">173</a> 
<a name="174" href="#174">174</a>         <em class="comment">// check the cache first</em>
<a name="175" href="#175">175</a>         <strong>boolean</strong> usedCache = false;
<a name="176" href="#176">176</a>         String searchCacheName = getSearchCacheName(type);
<a name="177" href="#177">177</a>         String cacheKey = <span class="string">"countBySearch::"</span> + type.getName() + <span class="string">":"</span> + search.toString();
<a name="178" href="#178">178</a>         <strong>if</strong> (getCacheProvider().exists(searchCacheName, cacheKey)) {
<a name="179" href="#179">179</a>             Long lCount = (Long) getCacheProvider().get(searchCacheName, cacheKey);
<a name="180" href="#180">180</a>             <strong>if</strong> (lCount != <strong>null</strong>) {
<a name="181" href="#181">181</a>                 count = lCount.longValue();
<a name="182" href="#182">182</a>                 usedCache = <strong>true</strong>;
<a name="183" href="#183">183</a>             }
<a name="184" href="#184">184</a>         }
<a name="185" href="#185">185</a> 
<a name="186" href="#186">186</a>         <strong>if</strong> (! usedCache) {
<a name="187" href="#187">187</a>             count = baseCountBySearch(type, search);
<a name="188" href="#188">188</a> 
<a name="189" href="#189">189</a>             <em class="comment">// cache the id results for the search</em>
<a name="190" href="#190">190</a>             getCacheProvider().put(searchCacheName, cacheKey, Long.valueOf(count));
<a name="191" href="#191">191</a>         }
<a name="192" href="#192">192</a>         <strong>return</strong> count;
<a name="193" href="#193">193</a>     }
<a name="194" href="#194">194</a> 
<a name="195" href="#195">195</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="196" href="#196">196</a>     <strong>public</strong> &lt;T> List&lt;T> findBySearch(Class&lt;T> type, <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search) {
<a name="197" href="#197">197</a>         checkClass(type);
<a name="198" href="#198">198</a>         <strong>if</strong> (search == <strong>null</strong>) {
<a name="199" href="#199">199</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"search cannot be null"</span>);
<a name="200" href="#200">200</a>         }
<a name="201" href="#201">201</a>         List&lt;T> results = <strong>new</strong> ArrayList&lt;T>();
<a name="202" href="#202">202</a> 
<a name="203" href="#203">203</a>         <em class="comment">// check the cache first</em>
<a name="204" href="#204">204</a>         <strong>boolean</strong> usedCache = false;
<a name="205" href="#205">205</a>         String cacheName = getCacheName(type);
<a name="206" href="#206">206</a>         String searchCacheName = getSearchCacheName(type);
<a name="207" href="#207">207</a>         String cacheKey = <span class="string">"findBySearch::"</span> + type.getName() + <span class="string">":"</span> + search.toString();
<a name="208" href="#208">208</a>         <strong>if</strong> (getCacheProvider().exists(searchCacheName, cacheKey)) {
<a name="209" href="#209">209</a>             String[] resultIds = (String[]) getCacheProvider().get(searchCacheName, cacheKey);
<a name="210" href="#210">210</a>             <strong>if</strong> (resultIds != <strong>null</strong>) {
<a name="211" href="#211">211</a>                 <strong>for</strong> (<strong>int</strong> i = 0; i &lt; resultIds.length; i++) {
<a name="212" href="#212">212</a>                     <strong>if</strong> (! getCacheProvider().exists(cacheName, resultIds[i])) {
<a name="213" href="#213">213</a>                         usedCache = false;
<a name="214" href="#214">214</a>                         <strong>break</strong>;
<a name="215" href="#215">215</a>                     }
<a name="216" href="#216">216</a>                     T entity = (T) getCacheProvider().get(cacheName, resultIds[i]);
<a name="217" href="#217">217</a>                     results.add(entity);
<a name="218" href="#218">218</a>                 }
<a name="219" href="#219">219</a>                 usedCache = <strong>true</strong>;
<a name="220" href="#220">220</a>             }
<a name="221" href="#221">221</a>         }
<a name="222" href="#222">222</a> 
<a name="223" href="#223">223</a>         <strong>if</strong> (! usedCache) {
<a name="224" href="#224">224</a>             String operation = <span class="string">"findBySearch"</span>;
<a name="225" href="#225">225</a>             beforeRead(operation, type, <strong>null</strong>, search);
<a name="226" href="#226">226</a> 
<a name="227" href="#227">227</a>             results = baseFindBySearch(type, search);
<a name="228" href="#228">228</a> 
<a name="229" href="#229">229</a>             <em class="comment">// run through the returned items for the interceptor and for caching</em>
<a name="230" href="#230">230</a>             List&lt;String> keys = <strong>new</strong> ArrayList&lt;String>();
<a name="231" href="#231">231</a>             <strong>for</strong> (T entity : results) {
<a name="232" href="#232">232</a>                 Object id = baseGetIdValue(entity);
<a name="233" href="#233">233</a>                 <em class="comment">// cache each returned item</em>
<a name="234" href="#234">234</a>                 String key = id.toString();
<a name="235" href="#235">235</a>                 keys.add(key);
<a name="236" href="#236">236</a>                 getCacheProvider().put(cacheName, key, entity);
<a name="237" href="#237">237</a>             }
<a name="238" href="#238">238</a>             <em class="comment">// cache the id results for the search</em>
<a name="239" href="#239">239</a>             String[] ids = keys.toArray(<strong>new</strong> String[keys.size()]);
<a name="240" href="#240">240</a>             getCacheProvider().put(searchCacheName, cacheKey, ids);
<a name="241" href="#241">241</a>             <em class="comment">// call the after interceptor</em>
<a name="242" href="#242">242</a>             afterRead(operation, type, ids, search, results.toArray(<strong>new</strong> Object[results.size()]));
<a name="243" href="#243">243</a>         }
<a name="244" href="#244">244</a>         <strong>return</strong> results;
<a name="245" href="#245">245</a>     }
<a name="246" href="#246">246</a> 
<a name="247" href="#247">247</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="248" href="#248">248</a>     <strong>public</strong> &lt;T> T findOneBySearch(Class&lt;T> type, <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search) {
<a name="249" href="#249">249</a>         checkClass(type);
<a name="250" href="#250">250</a>         <strong>if</strong> (search == <strong>null</strong>) {
<a name="251" href="#251">251</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"search cannot be null"</span>);
<a name="252" href="#252">252</a>         }
<a name="253" href="#253">253</a>         T entity = <strong>null</strong>;
<a name="254" href="#254">254</a> 
<a name="255" href="#255">255</a>         <em class="comment">// check the cache first</em>
<a name="256" href="#256">256</a>         <strong>boolean</strong> usedCache = false;
<a name="257" href="#257">257</a>         String cacheName = getCacheName(type);
<a name="258" href="#258">258</a>         String searchCacheName = getSearchCacheName(type);
<a name="259" href="#259">259</a>         String cacheKey = <span class="string">"findOneBySearch::"</span> + type.getName() + <span class="string">":"</span> + search.toString();
<a name="260" href="#260">260</a>         <strong>if</strong> (getCacheProvider().exists(searchCacheName, cacheKey)) {
<a name="261" href="#261">261</a>             usedCache = <strong>true</strong>;
<a name="262" href="#262">262</a>             String id = (String) getCacheProvider().get(searchCacheName, cacheKey);
<a name="263" href="#263">263</a>             <strong>if</strong> (id != <strong>null</strong>) {
<a name="264" href="#264">264</a>                 <strong>if</strong> (getCacheProvider().exists(cacheName, id)) {
<a name="265" href="#265">265</a>                     entity = (T) getCacheProvider().get(cacheName, id);
<a name="266" href="#266">266</a>                 }
<a name="267" href="#267">267</a>             }
<a name="268" href="#268">268</a>         }
<a name="269" href="#269">269</a> 
<a name="270" href="#270">270</a>         <strong>if</strong> (! usedCache) {
<a name="271" href="#271">271</a>             String operation = <span class="string">"findOneBySearch"</span>;
<a name="272" href="#272">272</a>             beforeRead(operation, type, <strong>null</strong>, search);
<a name="273" href="#273">273</a> 
<a name="274" href="#274">274</a>             search.setLimit(1); <em class="comment">// only return 1 item</em>
<a name="275" href="#275">275</a> 
<a name="276" href="#276">276</a>             entity = baseFindOneBySearch(type, search);
<a name="277" href="#277">277</a> 
<a name="278" href="#278">278</a>             String key = <strong>null</strong>;
<a name="279" href="#279">279</a>             <strong>if</strong> (entity != <strong>null</strong>) {
<a name="280" href="#280">280</a>                 Serializable id = baseGetIdValue(entity);
<a name="281" href="#281">281</a>                 afterRead(operation, type, <strong>new</strong> Serializable[] {id}, search, <strong>new</strong> Object[] {entity});
<a name="282" href="#282">282</a> 
<a name="283" href="#283">283</a>                 <strong>if</strong> (id != <strong>null</strong>) {
<a name="284" href="#284">284</a>                     <em class="comment">// cache the entity</em>
<a name="285" href="#285">285</a>                     key = id.toString();
<a name="286" href="#286">286</a>                     getCacheProvider().put(cacheName, key, entity);
<a name="287" href="#287">287</a>                 }
<a name="288" href="#288">288</a>             }
<a name="289" href="#289">289</a>             <em class="comment">// cache the search result</em>
<a name="290" href="#290">290</a>             getCacheProvider().put(searchCacheName, cacheKey, key);
<a name="291" href="#291">291</a>         }
<a name="292" href="#292">292</a>         <strong>return</strong> entity;
<a name="293" href="#293">293</a>     }
<a name="294" href="#294">294</a> 
<a name="295" href="#295">295</a> 
<a name="296" href="#296">296</a>     <em class="comment">// DEPRECATED</em>
<a name="297" href="#297">297</a> 
<a name="298" href="#298">298</a>     <em>/**<em>*</em></em>
<a name="299" href="#299">299</a> <em>     * @deprecated</em>
<a name="300" href="#300">300</a> <em>     */</em>
<a name="301" href="#301">301</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="302" href="#302">302</a>     <strong>public</strong> <strong>int</strong> countByProperties(Class entityClass, String[] objectProperties, Object[] values) {
<a name="303" href="#303">303</a>         <strong>int</strong>[] comparisons = <strong>new</strong> <strong>int</strong>[objectProperties.length];
<a name="304" href="#304">304</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; comparisons.length; i++) {
<a name="305" href="#305">305</a>             comparisons[i] = Restriction.EQUALS;
<a name="306" href="#306">306</a>         }
<a name="307" href="#307">307</a>         <strong>return</strong> countByProperties(entityClass, objectProperties, values, comparisons);
<a name="308" href="#308">308</a>     }
<a name="309" href="#309">309</a> 
<a name="310" href="#310">310</a>     <em>/**<em>*</em></em>
<a name="311" href="#311">311</a> <em>     * @deprecated</em>
<a name="312" href="#312">312</a> <em>     */</em>
<a name="313" href="#313">313</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="314" href="#314">314</a>     <strong>public</strong> <strong>int</strong> countByProperties(Class entityClass, String[] objectProperties, Object[] values,
<a name="315" href="#315">315</a>             <strong>int</strong>[] comparisons) {
<a name="316" href="#316">316</a>         <strong>if</strong> (objectProperties.length != values.length || values.length != comparisons.length) {
<a name="317" href="#317">317</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"All input arrays must be the same size"</span>);
<a name="318" href="#318">318</a>         }
<a name="319" href="#319">319</a>         <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>();
<a name="320" href="#320">320</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; values.length; i++) {
<a name="321" href="#321">321</a>             search.addRestriction( <strong>new</strong> Restriction(objectProperties[i], values[i], comparisons[i]) );
<a name="322" href="#322">322</a>         }
<a name="323" href="#323">323</a>         <strong>return</strong> (<strong>int</strong>) countBySearch(entityClass, search);
<a name="324" href="#324">324</a>     }
<a name="325" href="#325">325</a> 
<a name="326" href="#326">326</a>     <em>/**<em>* </em></em>
<a name="327" href="#327">327</a> <em>     * @deprecated</em>
<a name="328" href="#328">328</a> <em>     */</em>
<a name="329" href="#329">329</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="330" href="#330">330</a>     <strong>public</strong> List findByProperties(Class entityClass, String[] objectProperties, Object[] values) {
<a name="331" href="#331">331</a>         <strong>int</strong>[] comparisons = <strong>new</strong> <strong>int</strong>[objectProperties.length];
<a name="332" href="#332">332</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; comparisons.length; i++)
<a name="333" href="#333">333</a>             comparisons[i] = Restriction.EQUALS;
<a name="334" href="#334">334</a> 
<a name="335" href="#335">335</a>         <strong>return</strong> findByProperties(checkClass(entityClass), objectProperties, values, comparisons, 0, 0);
<a name="336" href="#336">336</a>     }
<a name="337" href="#337">337</a> 
<a name="338" href="#338">338</a>     <em>/**<em>* </em></em>
<a name="339" href="#339">339</a> <em>     * @deprecated</em>
<a name="340" href="#340">340</a> <em>     */</em>
<a name="341" href="#341">341</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="342" href="#342">342</a>     <strong>public</strong> List findByProperties(Class entityClass, String[] objectProperties, Object[] values,
<a name="343" href="#343">343</a>             <strong>int</strong>[] comparisons) {
<a name="344" href="#344">344</a>         <strong>return</strong> findByProperties(entityClass, objectProperties, values, comparisons, <strong>null</strong>, 0, 0);
<a name="345" href="#345">345</a>     }
<a name="346" href="#346">346</a> 
<a name="347" href="#347">347</a>     <em>/**<em>* </em></em>
<a name="348" href="#348">348</a> <em>     * @deprecated</em>
<a name="349" href="#349">349</a> <em>     */</em>
<a name="350" href="#350">350</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="351" href="#351">351</a>     <strong>public</strong> List findByProperties(Class entityClass, String[] objectProperties, Object[] values,
<a name="352" href="#352">352</a>             <strong>int</strong>[] comparisons, String[] sortProperties) {
<a name="353" href="#353">353</a>         <strong>return</strong> findByProperties(entityClass, objectProperties, values, comparisons, sortProperties, 0, 0);
<a name="354" href="#354">354</a>     }
<a name="355" href="#355">355</a> 
<a name="356" href="#356">356</a>     <em>/**<em>* </em></em>
<a name="357" href="#357">357</a> <em>     * @deprecated</em>
<a name="358" href="#358">358</a> <em>     */</em>
<a name="359" href="#359">359</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="360" href="#360">360</a>     <strong>public</strong> List findByProperties(Class entityClass, String[] objectProperties, Object[] values,
<a name="361" href="#361">361</a>             <strong>int</strong>[] comparisons, <strong>int</strong> firstResult, <strong>int</strong> maxResults) {
<a name="362" href="#362">362</a>         <strong>return</strong> findByProperties(entityClass, objectProperties, values, comparisons, <strong>null</strong>, firstResult,
<a name="363" href="#363">363</a>                 maxResults);
<a name="364" href="#364">364</a>     }
<a name="365" href="#365">365</a> 
<a name="366" href="#366">366</a>     <em>/**<em>*</em></em>
<a name="367" href="#367">367</a> <em>     * @deprecated</em>
<a name="368" href="#368">368</a> <em>     */</em>
<a name="369" href="#369">369</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="370" href="#370">370</a>     <strong>public</strong> List findByProperties(Class entityClass, String[] objectProperties, Object[] values,
<a name="371" href="#371">371</a>             <strong>int</strong>[] comparisons, String[] sortProperties, <strong>int</strong> firstResult, <strong>int</strong> maxResults) {
<a name="372" href="#372">372</a>         <strong>if</strong> (objectProperties.length != values.length || values.length != comparisons.length) {
<a name="373" href="#373">373</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"All input arrays must be the same size"</span>);
<a name="374" href="#374">374</a>         }
<a name="375" href="#375">375</a>         <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>();
<a name="376" href="#376">376</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; values.length; i++) {
<a name="377" href="#377">377</a>             search.addRestriction( <strong>new</strong> Restriction(objectProperties[i], values[i], comparisons[i]) );
<a name="378" href="#378">378</a>         }
<a name="379" href="#379">379</a>         <strong>if</strong> (sortProperties != <strong>null</strong>) {
<a name="380" href="#380">380</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; sortProperties.length; i++) {
<a name="381" href="#381">381</a>                 <strong>int</strong> location = sortProperties[i].indexOf(<span class="string">" "</span>);
<a name="382" href="#382">382</a>                 String property = sortProperties[i];
<a name="383" href="#383">383</a>                 <strong>if</strong> (location > 0) {
<a name="384" href="#384">384</a>                     property = sortProperties[i].substring(0, location);
<a name="385" href="#385">385</a>                 }
<a name="386" href="#386">386</a>                 <a href="../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a> order = <strong>null</strong>;
<a name="387" href="#387">387</a>                 <strong>if</strong> (sortProperties[i].endsWith(ByPropsFinder.DESC)) {
<a name="388" href="#388">388</a>                     order = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>(property, false);
<a name="389" href="#389">389</a>                 } <strong>else</strong> {
<a name="390" href="#390">390</a>                     order = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>(property, <strong>true</strong>);
<a name="391" href="#391">391</a>                 }
<a name="392" href="#392">392</a>                 search.addOrder( order );
<a name="393" href="#393">393</a>             }
<a name="394" href="#394">394</a>         }
<a name="395" href="#395">395</a>         search.setStart(firstResult);
<a name="396" href="#396">396</a>         search.setLimit(maxResults);
<a name="397" href="#397">397</a>         <strong>return</strong> findBySearch(entityClass, search);
<a name="398" href="#398">398</a>     }
<a name="399" href="#399">399</a> 
<a name="400" href="#400">400</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

